Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

setup.py → pyproject.toml #293

Merged

Conversation

DimitriPapadopoulos
Copy link
Contributor

@DimitriPapadopoulos DimitriPapadopoulos commented Jun 16, 2024

Fxies #288.

@DimitriPapadopoulos DimitriPapadopoulos marked this pull request as ready for review June 16, 2024 13:44
@CPBridge CPBridge self-assigned this Jun 21, 2024
@CPBridge CPBridge added the enhancement New feature or request label Jun 21, 2024
@CPBridge
Copy link
Collaborator

Thanks, looks good but I'll run a few careful tests before we merge

Copy link
Collaborator

@CPBridge CPBridge left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for taking the time to do this!

A couple of things:

  1. It appears that the license (and less importantly the platforms) did not make it across from setup.py to pyproject.toml.
  2. We should remove the requirements_doc.txt and requirements_test.txt as they are now redundant, right? Or is there some reason you left them in place?

@DimitriPapadopoulos
Copy link
Contributor Author

  1. The license is part of the classifiers:

        "License :: OSI Approved :: MIT License",
    

    I have not duplicated it in a license field because the Python Packaging User Guide reads:

    If you are using a standard, well-known license, it is not necessary to use this field. Instead, you should use one of the classifiers starting with License ::.

    Same for platforms, they are documented in the classifiers. There's no key dedicated to platforms anyway.

  2. I've removed requirements_doc.txt and requirements_test.txt.

@CPBridge
Copy link
Collaborator

Thanks! That makes sense.

But now the github actions are failing because they depend on the old requirements_test.txt. Could you please make the simple change to this line of run_unit_tests.yml to fix and get the CI pipeline running again?

@DimitriPapadopoulos
Copy link
Contributor Author

The CI jobs pass, I have also updated the documentation.

@CPBridge
Copy link
Collaborator

I have also updated the documentation.

Ah yes, good catch. Thanks for your help!

@CPBridge CPBridge self-requested a review June 23, 2024 13:18
@CPBridge CPBridge merged commit 8ddcd6b into ImagingDataCommons:master Jun 23, 2024
13 checks passed
@DimitriPapadopoulos DimitriPapadopoulos deleted the pyproject.toml branch June 23, 2024 13:37
@DimitriPapadopoulos
Copy link
Contributor Author

Unfortunately, I missed an occurrence of requirements_docs.txt:

- requirements: requirements_docs.txt

@CPBridge
Copy link
Collaborator

Yeah I just noticed that too, I'll take care of it. Thanks!

@DimitriPapadopoulos
Copy link
Contributor Author

Perhaps you need to restore requirements_docs.txt. It looks like pyproject.toml won't be supported by readthedocs:
readthedocs/readthedocs.org#8599

@DimitriPapadopoulos
Copy link
Contributor Author

My wrong, this is covered by packages:

version: 2

python:
  install:
    - method: pip
      path: .
      extra_requirements:
        - docs

With the previous settings, Read the Docs will execute the next commands:

pip install .[docs]

@CPBridge
Copy link
Collaborator

Yup, I came across and implemented the same solution. Builds just passed on readthedocs

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants